# vIRCBot

*A simple IRC bot*

## License

This bot has a license different from the one used in most tools I
wrote. It's **AGPLv3-licensed**


	Copyright (C) 2022 Ferass EL HAFIDI <vitali64pmemail@protonmail.com>

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU Affero General Public License as
	published by the Free Software Foundation, either version 3 of the
	License, or (at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU Affero General Public License for more details.

	You should have received a copy of the GNU Affero General Public License
	along with this program.  If not, see <https://www.gnu.org/licenses/>.


## Requirements

This requires `miniirc` and `miniirc_extras`.

	$ pip install miniirc && pip install miniirc_extras

## Running

Just run:

	$ python main.py

## Configuration

There's a file called `bot_config.py`. It's a python file.

Those are the main options you may want to change:

`owner` : Owner name. It's used to change the bot's nick among other things |

`channels` : Channels to join (default: `#librespeech`)

`nick` : The bot's nickname (can be changed while running, default: `speechbot`)

`server` and `serverport` : The server URL and port 
(default: `irc.libera.chat` and `6697`)

`nickserv` : Nickserv account name and password (default: `None`)

There are other options but they won't be detailed here (mostly because it's 
pretty easy to figure out what they do).

## NOTE

This repo is *temporary*. It may get deleted and moved away at any time.
